<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>io_context::wrap</title>
    <link rel="stylesheet" href="../../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../../index.html" title="Asio">
    <link rel="up" href="../io_context.html" title="io_context">
    <link rel="prev" href="use_service/overload2.html" title="io_context::use_service (2 of 2 overloads)">
    <link rel="next" href="_io_context.html" title="io_context::~io_context">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="use_service/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                                      href="../io_context.html"><img
        src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png"
                                                                                            alt="Home"></a><a
        accesskey="n" href="_io_context.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h4 class="title">
                <a name="asio.reference.io_context.wrap"></a><a class="link" href="wrap.html" title="io_context::wrap">io_context::wrap</a>
            </h4></div>
        </div>
    </div>
    <p>
        <a class="indexterm" name="asio.indexterm.io_context.wrap"></a>
        (Deprecated: Use <a class="link" href="../bind_executor.html" title="bind_executor"><code
            class="computeroutput"><span class="identifier">bind_executor</span></code></a>.) Create a new handler
        that automatically dispatches the wrapped handler on the <a class="link" href="../io_context.html"
                                                                    title="io_context"><code
            class="computeroutput"><span class="identifier">io_context</span></code></a>.
    </p>
    <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <a class="link" href="../Handler.html" title="Handlers">Handler</a><span
                class="special">&gt;</span>
<span class="identifier">unspecified</span> <span class="identifier">wrap</span><span class="special">(</span>
    <span class="identifier">Handler</span> <span class="identifier">handler</span><span class="special">);</span>
</pre>
    <p>
        This function is used to create a new handler function object that, when
        invoked, will automatically pass the wrapped handler to the <a class="link" href="../io_context.html"
                                                                       title="io_context"><code
            class="computeroutput"><span class="identifier">io_context</span></code></a> object's dispatch function.
    </p>
    <h6>
        <a name="asio.reference.io_context.wrap.h0"></a>
        <span><a name="asio.reference.io_context.wrap.parameters"></a></span><a class="link"
                                                                                href="wrap.html#asio.reference.io_context.wrap.parameters">Parameters</a>
    </h6>
    <div class="variablelist">
        <p class="title"><b></b></p>
        <dl>
            <dt><span class="term">handler</span></dt>
            <dd>
                <p>
                    The handler to be wrapped. The <a class="link" href="../io_context.html" title="io_context"><code
                        class="computeroutput"><span class="identifier">io_context</span></code></a> will make a copy
                    of the handler object as required. The function signature of the
                    handler must be:
                </p>
                <pre class="programlisting"><span class="keyword">void</span> <span
                        class="identifier">handler</span><span class="special">(</span><span
                        class="identifier">A1</span> <span class="identifier">a1</span><span
                        class="special">,</span> <span class="special">...</span> <span
                        class="identifier">An</span> <span class="identifier">an</span><span class="special">);</span>
</pre>
            </dd>
        </dl>
    </div>
    <h6>
        <a name="asio.reference.io_context.wrap.h1"></a>
        <span><a name="asio.reference.io_context.wrap.return_value"></a></span><a class="link"
                                                                                  href="wrap.html#asio.reference.io_context.wrap.return_value">Return
        Value</a>
    </h6>
    <p>
        A function object that, when invoked, passes the wrapped handler to the
        <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput"><span
                class="identifier">io_context</span></code></a>
        object's dispatch function. Given a function object with the signature:
    </p>
    <pre class="programlisting"><span class="identifier">R</span> <span class="identifier">f</span><span
            class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span
            class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span
            class="identifier">an</span><span class="special">);</span>
</pre>
    <p>
        If this function object is passed to the wrap function like so:
    </p>
    <pre class="programlisting"><span class="identifier">io_context</span><span class="special">.</span><span
            class="identifier">wrap</span><span class="special">(</span><span class="identifier">f</span><span
            class="special">);</span>
</pre>
    <p>
        then the return value is a function object with the signature
    </p>
    <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">g</span><span
            class="special">(</span><span class="identifier">A1</span> <span class="identifier">a1</span><span
            class="special">,</span> <span class="special">...</span> <span class="identifier">An</span> <span
            class="identifier">an</span><span class="special">);</span>
</pre>
    <p>
        that, when invoked, executes code equivalent to:
    </p>
    <pre class="programlisting"><span class="identifier">io_context</span><span class="special">.</span><span
            class="identifier">dispatch</span><span class="special">(</span><span class="identifier">boost</span><span
            class="special">::</span><span class="identifier">bind</span><span class="special">(</span><span
            class="identifier">f</span><span class="special">,</span> <span class="identifier">a1</span><span
            class="special">,</span> <span class="special">...</span> <span class="identifier">an</span><span
            class="special">));</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="use_service/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                                      href="../io_context.html"><img
        src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png"
                                                                                            alt="Home"></a><a
        accesskey="n" href="_io_context.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
